Skip to content

docs: update README to match current Provider architecture and API#49

Merged
best merged 1 commit into
masterfrom
docs/readme-update
Feb 23, 2026
Merged

docs: update README to match current Provider architecture and API#49
best merged 1 commit into
masterfrom
docs/readme-update

Conversation

@best
Copy link
Copy Markdown
Contributor

@best best commented Feb 23, 2026

Summary

Closes #46

  • Quick Start: Added registerProvider() + createOpenAIProvider() imports and apiKey config so the example actually works when copy-pasted
  • Provider architecture: Documented the two adapter base classes (OpenAIAdapter for OpenAI-compatible APIs, AnthropicAdapter for Anthropic-compatible APIs)
  • Model configuration: Documented createModel() config parameter (apiKey, baseURL, temperature, maxTokens, topP, stop) and per-call overrides
  • Custom endpoints: Added section showing how to use any OpenAI-compatible or Anthropic-compatible service via baseURL (Azure, LiteLLM, vLLM, etc.)
  • Provider table: Added Adapter column showing which base class each provider uses; added env var table
  • Comparison table: Updated Vercel AI SDK entries (now has agent loop, MCP support); added Agent loop row; updated Provider support to mention compatible endpoints

Test plan

  • Verify Quick Start code matches actual API (registerProvider + createModel with config)
  • Verify all documented config options exist in ModelConfig type
  • Verify env var names match source code for each provider
  • Verify comparison table claims against current Vercel AI SDK docs

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 AI Code Review

Automated review for PR #49informational only, does not block merge.

Checklist

Item Notes
⚠️ Type Safety 4 use(s) of any detected
Error Handling No issues detected
⚠️ Test Coverage No test files changed; consider adding/updating tests
API Consistency No public API changes
Breaking Changes No breaking changes detected

Stats

  • 📁 Files changed: 1 (0 TypeScript)
  • ➕ Lines added: 97
  • 🧪 Test files updated: 0

2 check(s) need attention.

Powered by openlinkos/agent · AI PR Review workflow

@best best merged commit b352791 into master Feb 23, 2026
5 checks passed
@best best deleted the docs/readme-update branch February 23, 2026 05:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Update README to match current Provider architecture and API

1 participant